Create a new carrier assignment

Only one carrier assignment is associated with a company-shipment combo at a time. Posting here will overwrite the companies carrier assignment. Carrier assignments are only shown to the user who sets it

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

Request Body schema: application/json
required
carrier_reference_code
string or null
created_at
string or null <date-time>
object (Company)
Array of objects (ShipmentChargeLineItem)

Costs owed to vendor as the customer records them, readable by both customer and vendor but writable only by the customer

id
string or null <uuid>
is_assigned_carrier
boolean
updated_at
string or null <date-time>
required
object (Company)
Array of objects (ShipmentChargeLineItem)

Costs owed to vendor as the vendor records them, readable by both customer and vendor but writable only by the vendor

vendor_point_of_contact
string or null <uuid>
Responses
201

Successfully created a carrier assignment

Response Schema: application/json
carrier_reference_code
string or null
created_at
string or null <date-time>
object (Company)
Array of objects (ShipmentChargeLineItem)

Costs owed to vendor as the customer records them, readable by both customer and vendor but writable only by the customer

id
string or null <uuid>
is_assigned_carrier
boolean
updated_at
string or null <date-time>
required
object (Company)
Array of objects (ShipmentChargeLineItem)

Costs owed to vendor as the vendor records them, readable by both customer and vendor but writable only by the vendor

vendor_point_of_contact
string or null <uuid>
default

Default error response

post/shipments/{shipmentId}/carrier-assignments/
Request samples
application/json
{
  • "carrier_reference_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer": {
    },
  • "customer_charge_line_items": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_assigned_carrier": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vendor": {
    },
  • "vendor_charge_line_items": [
    ],
  • "vendor_point_of_contact": "f21065b9-a4a6-4edb-bb46-20a9d9f7a8f0"
}
Response samples
application/json
{
  • "carrier_reference_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer": {
    },
  • "customer_charge_line_items": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_assigned_carrier": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vendor": {
    },
  • "vendor_charge_line_items": [
    ],
  • "vendor_point_of_contact": "f21065b9-a4a6-4edb-bb46-20a9d9f7a8f0"
}
Copyright © Shipwell 2024. All right reserved.